Cisco-IOS-XR-ipv4-vrrp-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-vrrp-cfg@2018-05-19.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key Mandatory OptionalPaths
VRRP - Update
Update operation of resource: vrrp
vrrpbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRRP - Create
Create operation of resource: vrrp
vrrpbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRRP - Delete
Delete operation of resource: vrrp
Successful operation
Internal Error
Response Content-Types: application/json
VRRP - Retrieve
Retrieve operation of resource: vrrp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
}
}
]
}
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{
"state-change-disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{
"state-change-disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"state-change-disable": [ null ]
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, }
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, }
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, }
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, "virtual-router": [ null ]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, "virtual-router": [ null ]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mac-refresh": "integer", "reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string", "interval": "integer",
"detection-multiplier": "integer"
}, {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}, {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, "virtual-router": [ null ]
}
}
}
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"accept-mode-disable": [ null ],
"follow": "string", "auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
}
}
]
}, { "auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}, {
"ip-address": "string"
}
]
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
VERSION3 - Update
Update operation of resource: version3
version3body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION3 - Create
Create operation of resource: version3
version3body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION3 - Delete
Delete operation of resource: version3
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VERSION3 - Retrieve
Retrieve operation of resource: version3
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
VIRTUAL-ROUTERS - Update
Update operation of resource: virtual-routers
virtual-routersbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Create
Create operation of resource: virtual-routers
virtual-routersbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Delete
Delete operation of resource: virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Retrieve
Retrieve operation of resource: virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
VIRTUAL-ROUTER - Update
Update operation of resource: virtual-router
virtual-routerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Create
Create operation of resource: virtual-router
virtual-routerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Delete
Delete operation of resource: virtual-router
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Retrieve
Retrieve operation of resource: virtual-router
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
GLOBAL-IPV6-ADDRESSES - Update
Update operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Create
Create operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Delete
Delete operation of resource: global-ipv6-addresses
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: global-ipv6-addresses
ID of interface-name
ID of vr-id
Successful operation
Internal Error
GLOBAL-IPV6-ADDRESS - Update
Update operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of vr-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Create
Create operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of vr-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Delete
Delete operation of resource: global-ipv6-address
ID of interface-name
ID of vr-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: global-ipv6-address
ID of interface-name
ID of vr-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
TRACKS - Update
Update operation of resource: tracks
tracksbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Create
Create operation of resource: tracks
tracksbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Delete
Delete operation of resource: tracks
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Retrieve
Retrieve operation of resource: tracks
ID of interface-name
ID of vr-id
Successful operation
Internal Error
TRACK - Update
Update operation of resource: track
trackbody object
ID of interface-name
ID of vr-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Create
Create operation of resource: track
trackbody object
ID of interface-name
ID of vr-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Delete
Delete operation of resource: track
ID of interface-name
ID of vr-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Retrieve
Retrieve operation of resource: track
ID of interface-name
ID of vr-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"interface-name": "string"
}
TIMER - Update
Update operation of resource: timer
timerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Create
Create operation of resource: timer
timerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Delete
Delete operation of resource: timer
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Retrieve
Retrieve operation of resource: timer
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
TRACKED-OBJECTS - Update
Update operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Create
Create operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Delete
Delete operation of resource: tracked-objects
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Retrieve
Retrieve operation of resource: tracked-objects
ID of interface-name
ID of vr-id
Successful operation
Internal Error
TRACKED-OBJECT - Update
Update operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of vr-id
ID of object-name
Request Content-Types: application/json
Request Example
{
"object-name": "string",
"priority-decrement": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Create
Create operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of vr-id
ID of object-name
Request Content-Types: application/json
Request Example
{
"object-name": "string",
"priority-decrement": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Delete
Delete operation of resource: tracked-object
ID of interface-name
ID of vr-id
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Retrieve
Retrieve operation of resource: tracked-object
ID of interface-name
ID of vr-id
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"object-name": "string",
"priority-decrement": "integer"
}
LINK-LOCAL-IPV6-ADDRESS - Update
Update operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"auto-configure": "boolean",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Create
Create operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"auto-configure": "boolean",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Delete
Delete operation of resource: link-local-ipv6-address
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: link-local-ipv6-address
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-configure": "boolean",
"ip-address": "string"
}
SLAVE-VIRTUAL-ROUTERS - Update
Update operation of resource: slave-virtual-routers
slave-virtual-routersbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTERS - Create
Create operation of resource: slave-virtual-routers
slave-virtual-routersbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTERS - Delete
Delete operation of resource: slave-virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTERS - Retrieve
Retrieve operation of resource: slave-virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}
SLAVE-VIRTUAL-ROUTER - Update
Update operation of resource: slave-virtual-router
slave-virtual-routerbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTER - Create
Create operation of resource: slave-virtual-router
slave-virtual-routerbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTER - Delete
Delete operation of resource: slave-virtual-router
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTER - Retrieve
Retrieve operation of resource: slave-virtual-router
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
LINK-LOCAL-IPV6-ADDRESS - Update
Update operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of slave-virtual-router-id
Request Content-Types: application/json
Request Example
{
"auto-configure": "boolean",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Create
Create operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of slave-virtual-router-id
Request Content-Types: application/json
Request Example
{
"auto-configure": "boolean",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Delete
Delete operation of resource: link-local-ipv6-address
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: link-local-ipv6-address
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-configure": "boolean",
"ip-address": "string"
}
GLOBAL-IPV6-ADDRESSES - Update
Update operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Create
Create operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Delete
Delete operation of resource: global-ipv6-addresses
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: global-ipv6-addresses
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
GLOBAL-IPV6-ADDRESS - Update
Update operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Create
Create operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Delete
Delete operation of resource: global-ipv6-address
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: global-ipv6-address
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
DELAY - Update
Update operation of resource: delay
delaybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"reload-delay": "integer",
"min-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Create
Create operation of resource: delay
delaybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"reload-delay": "integer",
"min-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Delete
Delete operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Retrieve
Retrieve operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reload-delay": "integer",
"min-delay": "integer"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}, { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}, {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
VERSION3 - Update
Update operation of resource: version3
version3body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION3 - Create
Create operation of resource: version3
version3body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION3 - Delete
Delete operation of resource: version3
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VERSION3 - Retrieve
Retrieve operation of resource: version3
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string", "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer", {
"object-name": "string",
"priority-decrement": "integer"
}
]
}, {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
VIRTUAL-ROUTERS - Update
Update operation of resource: virtual-routers
virtual-routersbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Create
Create operation of resource: virtual-routers
virtual-routersbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Delete
Delete operation of resource: virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Retrieve
Retrieve operation of resource: virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
VIRTUAL-ROUTER - Update
Update operation of resource: virtual-router
virtual-routerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Create
Create operation of resource: virtual-router
virtual-routerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Delete
Delete operation of resource: virtual-router
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Retrieve
Retrieve operation of resource: virtual-router
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
TIMER - Update
Update operation of resource: timer
timerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Create
Create operation of resource: timer
timerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Delete
Delete operation of resource: timer
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Retrieve
Retrieve operation of resource: timer
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
SECONDARY-IPV4-ADDRESSES - Update
Update operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Create
Create operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Delete
Delete operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of vr-id
Successful operation
Internal Error
SECONDARY-IPV4-ADDRESS - Update
Update operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of vr-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Create
Create operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of vr-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Delete
Delete operation of resource: secondary-ipv4-address
ID of interface-name
ID of vr-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: secondary-ipv4-address
ID of interface-name
ID of vr-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
TRACKED-OBJECTS - Update
Update operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Create
Create operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Delete
Delete operation of resource: tracked-objects
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Retrieve
Retrieve operation of resource: tracked-objects
ID of interface-name
ID of vr-id
Successful operation
Internal Error
TRACKED-OBJECT - Update
Update operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of vr-id
ID of object-name
Request Content-Types: application/json
Request Example
{
"object-name": "string",
"priority-decrement": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Create
Create operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of vr-id
ID of object-name
Request Content-Types: application/json
Request Example
{
"object-name": "string",
"priority-decrement": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Delete
Delete operation of resource: tracked-object
ID of interface-name
ID of vr-id
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Retrieve
Retrieve operation of resource: tracked-object
ID of interface-name
ID of vr-id
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"object-name": "string",
"priority-decrement": "integer"
}
TRACKS - Update
Update operation of resource: tracks
tracksbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Create
Create operation of resource: tracks
tracksbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Delete
Delete operation of resource: tracks
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Retrieve
Retrieve operation of resource: tracks
ID of interface-name
ID of vr-id
Successful operation
Internal Error
TRACK - Update
Update operation of resource: track
trackbody object
ID of interface-name
ID of vr-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Create
Create operation of resource: track
trackbody object
ID of interface-name
ID of vr-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Delete
Delete operation of resource: track
ID of interface-name
ID of vr-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Retrieve
Retrieve operation of resource: track
ID of interface-name
ID of vr-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"interface-name": "string"
}
SLAVE-VIRTUAL-ROUTERS - Update
Update operation of resource: slave-virtual-routers
slave-virtual-routersbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTERS - Create
Create operation of resource: slave-virtual-routers
slave-virtual-routersbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTERS - Delete
Delete operation of resource: slave-virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTERS - Retrieve
Retrieve operation of resource: slave-virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer", {
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}
SLAVE-VIRTUAL-ROUTER - Update
Update operation of resource: slave-virtual-router
slave-virtual-routerbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTER - Create
Create operation of resource: slave-virtual-router
slave-virtual-routerbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTER - Delete
Delete operation of resource: slave-virtual-router
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-VIRTUAL-ROUTER - Retrieve
Retrieve operation of resource: slave-virtual-router
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
SECONDARY-IPV4-ADDRESSES - Update
Update operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Create
Create operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Delete
Delete operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of slave-virtual-router-id
Successful operation
Internal Error
SECONDARY-IPV4-ADDRESS - Update
Update operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Create
Create operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Delete
Delete operation of resource: secondary-ipv4-address
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: secondary-ipv4-address
ID of interface-name
ID of slave-virtual-router-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
VERSION2 - Update
Update operation of resource: version2
version2body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Create
Create operation of resource: version2
version2body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Delete
Delete operation of resource: version2
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Retrieve
Retrieve operation of resource: version2
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
VIRTUAL-ROUTERS - Update
Update operation of resource: virtual-routers
virtual-routersbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Create
Create operation of resource: virtual-routers
virtual-routersbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Delete
Delete operation of resource: virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTERS - Retrieve
Retrieve operation of resource: virtual-routers
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
VIRTUAL-ROUTER - Update
Update operation of resource: virtual-router
virtual-routerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Create
Create operation of resource: virtual-router
virtual-routerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Delete
Delete operation of resource: virtual-router
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-ROUTER - Retrieve
Retrieve operation of resource: virtual-router
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string", {
"priority": "integer",
"interface-name": "string"
}
]
}, "advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer", {
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
TIMER - Update
Update operation of resource: timer
timerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Create
Create operation of resource: timer
timerbody object
ID of interface-name
ID of vr-id
Request Content-Types: application/json
Request Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Delete
Delete operation of resource: timer
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMER - Retrieve
Retrieve operation of resource: timer
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
SECONDARY-IPV4-ADDRESSES - Update
Update operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Create
Create operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Delete
Delete operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of vr-id
Successful operation
Internal Error
SECONDARY-IPV4-ADDRESS - Update
Update operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of vr-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Create
Create operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of vr-id
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Delete
Delete operation of resource: secondary-ipv4-address
ID of interface-name
ID of vr-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: secondary-ipv4-address
ID of interface-name
ID of vr-id
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
TRACKS - Update
Update operation of resource: tracks
tracksbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Create
Create operation of resource: tracks
tracksbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Delete
Delete operation of resource: tracks
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKS - Retrieve
Retrieve operation of resource: tracks
ID of interface-name
ID of vr-id
Successful operation
Internal Error
TRACK - Update
Update operation of resource: track
trackbody object
ID of interface-name
ID of vr-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Create
Create operation of resource: track
trackbody object
ID of interface-name
ID of vr-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Delete
Delete operation of resource: track
ID of interface-name
ID of vr-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACK - Retrieve
Retrieve operation of resource: track
ID of interface-name
ID of vr-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"interface-name": "string"
}
TRACKED-OBJECTS - Update
Update operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Create
Create operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Delete
Delete operation of resource: tracked-objects
ID of interface-name
ID of vr-id
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Retrieve
Retrieve operation of resource: tracked-objects
ID of interface-name
ID of vr-id
Successful operation
Internal Error
TRACKED-OBJECT - Update
Update operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of vr-id
ID of object-name
Request Content-Types: application/json
Request Example
{
"object-name": "string",
"priority-decrement": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Create
Create operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of vr-id
ID of object-name
Request Content-Types: application/json
Request Example
{
"object-name": "string",
"priority-decrement": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Delete
Delete operation of resource: tracked-object
ID of interface-name
ID of vr-id
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Retrieve
Retrieve operation of resource: tracked-object
ID of interface-name
ID of vr-id
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"object-name": "string",
"priority-decrement": "integer"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"detection-multiplier": "integer"
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
VIEWS - Update
Update operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
AGENT - Update
Update operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknown-user": [ null ]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
TARGETS - Update
Update operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
VRRP - Update
Update operation of resource: vrrp
vrrpbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRRP - Create
Create operation of resource: vrrp
vrrpbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRRP - Delete
Delete operation of resource: vrrp
Successful operation
Internal Error
Response Content-Types: application/json
VRRP - Retrieve
Retrieve operation of resource: vrrp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ]
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
Successful operation
Internal Error
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rulename": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string"
}
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"drop-time": "integer",
"throttle-rate": "integer"
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
Schema Definitions
vrrp_schema:
VRRP configuration
- interfaces: object
-
Interface configuration table
-
- interface: object[]
-
The interface being configured
-
object - mac-refresh: integer
-
VRRP Slave MAC-refresh rate in seconds
range:"0..10000" units:"second" default:"60" - delay: object
-
Minimum and Reload Delay
-
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
- interface-name: string
-
Interface name to configure
- bfd: object
-
BFD configuration
-
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
- ipv6: object
-
IPv6 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- session-name: string
-
VRRP Session Name
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
- ipv4: object
-
IPv4 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- version2: object
-
Version 2 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
- enable: null
-
Enable vrrp process
- logging: object
-
VRRP logging options
-
- state-change-disable: null
-
VRRP state change IOS messages disable
Example
{
"interfaces": {
"interface": [
{
"mac-refresh": "integer",
"delay": {
"reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string",
"bfd": {
"interval": "integer",
"detection-multiplier": "integer"
},
"ipv6": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer",
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
}
]
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
},
"ipv4": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
},
"version2": {
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
},
"version3": {}
}
}
]
}
}
logging_schema:
VRRP logging options
- state-change-disable: null
-
VRRP state change IOS messages disable
Example
{
"state-change-disable": [ null ]
}
interfaces_schema:
Interface configuration table
- interface: object[]
-
The interface being configured
-
object - mac-refresh: integer
-
VRRP Slave MAC-refresh rate in seconds
range:"0..10000" units:"second" default:"60" - delay: object
-
Minimum and Reload Delay
-
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
- interface-name: string
-
Interface name to configure
- bfd: object
-
BFD configuration
-
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
- ipv6: object
-
IPv6 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- session-name: string
-
VRRP Session Name
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
- ipv4: object
-
IPv4 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- version2: object
-
Version 2 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"interface": [
{
"mac-refresh": "integer",
"delay": {
"reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string",
"bfd": {
"interval": "integer",
"detection-multiplier": "integer"
},
"ipv6": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer",
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
}
]
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
},
"ipv4": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
},
"version2": {
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
},
"version3": {
"virtual-routers": {}
}
}
}
]
}
interface_schema:
- mac-refresh: integer
-
VRRP Slave MAC-refresh rate in seconds
range:"0..10000" units:"second" default:"60" - delay: object
-
Minimum and Reload Delay
-
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
- interface-name: string
-
Interface name to configure
- bfd: object
-
BFD configuration
-
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
- ipv6: object
-
IPv6 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- session-name: string
-
VRRP Session Name
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
- ipv4: object
-
IPv4 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- version2: object
-
Version 2 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"mac-refresh": "integer",
"delay": {
"reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string",
"bfd": {
"interval": "integer",
"detection-multiplier": "integer"
},
"ipv6": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer",
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
}
]
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
},
"ipv4": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
},
"version2": {
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
},
"version3": {
"virtual-routers": {
"virtual-router": [
{}
]
}
}
}
}
ipv6_schema:
IPv6 VRRP configuration
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- session-name: string
-
VRRP Session Name
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer",
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
}
]
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
version3_schema:
Version 3 VRRP configuration
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"virtual-routers": {
"virtual-router": [
{
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string",
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
virtual-routers_schema:
The VRRP virtual router configuration table
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
Example
{
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
virtual-router_schema:
- tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
Example
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
global-ipv6-addresses_schema:
The table of VRRP virtual global IPv6 addresses
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
Example
{
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
global-ipv6-address_schema:
- ip-address: string
-
VRRP virtual global IPv6 address
Example
{
"ip-address": "string"
}
tracks_schema:
Track an item, reducing priority if it goes down
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
Example
{
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
}
track_schema:
- priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
Example
{
"priority": "integer",
"interface-name": "string"
}
timer_schema:
Set advertisement timer
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
tracked-objects_schema:
Track an object, reducing priority if it goes down
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
Example
{
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
}
tracked-object_schema:
- object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
Example
{
"object-name": "string",
"priority-decrement": "integer"
}
link-local-ipv6-address_schema:
The VRRP IPv6 virtual linklocal address
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
default: false - ip-address: string
-
VRRP IPv6 virtual linklocal address
Example
{
"auto-configure": "boolean",
"ip-address": "string"
}
slave-virtual-routers_schema:
The VRRP slave group configuration table
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
Example
{
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}
slave-virtual-router_schema:
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
Example
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
delay_schema:
Minimum and Reload Delay
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
Example
{
"reload-delay": "integer",
"min-delay": "integer"
}
ipv4_schema:
IPv4 VRRP configuration
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- version2: object
-
Version 2 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
},
"version2": {
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string",
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
}
secondary-ipv4-addresses_schema:
The table of VRRP secondary IPv4 addresses
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
Example
{
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
}
secondary-ipv4-address_schema:
- ip-address: string
-
VRRP Secondary IPv4 address
Example
{
"ip-address": "string"
}
version2_schema:
Version 2 VRRP configuration
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
Example
{
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
bfd_schema:
BFD configuration
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
Example
{
"interval": "integer",
"detection-multiplier": "integer"
}
a1_vrrp_schema:
VRRP-MIB notification configuration
- enable: null
-
Enable VRRP-MIB notifications
Example
{
"enable": [ null ]
}
a1_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a1_interfaces_schema:
Interface configuration table
- interface: object[]
-
The interface being configured
-
object - mac-refresh: integer
-
VRRP Slave MAC-refresh rate in seconds
range:"0..10000" units:"second" default:"60" - delay: object
-
Minimum and Reload Delay
-
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
- interface-name: string
-
Interface name to configure
- bfd: object
-
BFD configuration
-
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
- ipv6: object
-
IPv6 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- session-name: string
-
VRRP Session Name
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
- ipv4: object
-
IPv4 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- version2: object
-
Version 2 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"interface": [
{
"mac-refresh": "integer",
"delay": {
"reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string",
"bfd": {
"interval": "integer",
"detection-multiplier": "integer"
},
"ipv6": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer",
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
}
]
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
},
"ipv4": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
},
"version2": {
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
},
"version3": {
"virtual-routers": {}
}
}
}
]
}
a1_interface_schema:
- mac-refresh: integer
-
VRRP Slave MAC-refresh rate in seconds
range:"0..10000" units:"second" default:"60" - delay: object
-
Minimum and Reload Delay
-
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
- interface-name: string
-
Interface name to configure
- bfd: object
-
BFD configuration
-
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
- ipv6: object
-
IPv6 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - link-local-ipv6-address: object
-
The VRRP IPv6 virtual linklocal address
-
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- global-ipv6-addresses: object
-
The table of VRRP virtual global IPv6 addresses
-
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- session-name: string
-
VRRP Session Name
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
- ipv4: object
-
IPv4 VRRP configuration
-
- slave-virtual-routers: object
-
The VRRP slave group configuration table
-
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- version2: object
-
Version 2 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
- version3: object
-
Version 3 VRRP configuration
-
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"mac-refresh": "integer",
"delay": {
"reload-delay": "integer",
"min-delay": "integer"
},
"interface-name": "string",
"bfd": {
"interval": "integer",
"detection-multiplier": "integer"
},
"ipv6": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"slave-virtual-router-id": "integer",
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
}
]
},
"version3": {
"virtual-routers": {
"virtual-router": [
{
"link-local-ipv6-address": {
"auto-configure": "boolean",
"ip-address": "string"
},
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"global-ipv6-addresses": {
"global-ipv6-address": [
{
"ip-address": "string"
}
]
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"accept-mode-disable": [ null ],
"session-name": "string",
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
},
"ipv4": {
"slave-virtual-routers": {
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
},
"version2": {
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
},
"version3": {
"virtual-routers": {
"virtual-router": [
{}
]
}
}
}
}
a1_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_version3_schema:
Version 3 VRRP configuration
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- priority: integer
-
Priority value
range:"1..254" default:"100" - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0"
Example
{
"virtual-routers": {
"virtual-router": [
{
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"primary-ipv4-address": "string",
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"priority": "integer",
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"preempt": "integer"
}
]
}
}
a1_virtual-routers_schema:
The VRRP virtual router configuration table
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
Example
{
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
a1_virtual-router_schema:
- tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
Example
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
a1_global-ipv6-addresses_schema:
The table of VRRP virtual global IPv6 addresses
- global-ipv6-address: object[]
-
A VRRP virtual global IPv6 IP address
-
object - ip-address: string
-
VRRP virtual global IPv6 address
Example
{
"global-ipv6-address": [
{
"ip-address": "string"
}
]
}
a1_global-ipv6-address_schema:
- ip-address: string
-
VRRP virtual global IPv6 address
Example
{
"ip-address": "string"
}
a1_tracks_schema:
Track an item, reducing priority if it goes down
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
Example
{
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
}
a1_track_schema:
- priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
Example
{
"priority": "integer",
"interface-name": "string"
}
a1_timer_schema:
Set advertisement timer
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
Example
{
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
}
a1_tracked-objects_schema:
Track an object, reducing priority if it goes down
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
Example
{
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
}
a1_tracked-object_schema:
- object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
Example
{
"object-name": "string",
"priority-decrement": "integer"
}
a1_link-local-ipv6-address_schema:
The VRRP IPv6 virtual linklocal address
- auto-configure: boolean
-
TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured
- ip-address: string
-
VRRP IPv6 virtual linklocal address
Example
{
"auto-configure": "boolean",
"ip-address": "string"
}
a1_slave-virtual-routers_schema:
The VRRP slave group configuration table
- slave-virtual-router: object[]
-
The VRRP slave being configured
-
object - accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
Example
{
"slave-virtual-router": [
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
]
}
a1_slave-virtual-router_schema:
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- follow: string
-
VRRP Session name for this slave to follow
- slave-virtual-router-id: integer
-
Virtual Router ID
range:"1..255" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
Example
{
"accept-mode-disable": [ null ],
"follow": "string",
"slave-virtual-router-id": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"primary-ipv4-address": "string"
}
a1_delay_schema:
Minimum and Reload Delay
- reload-delay: integer
-
Reload delay in seconds
range:"0..10000" units:"second" - min-delay: integer
-
Minimum delay in seconds
range:"0..10000" units:"second"
Example
{
"reload-delay": "integer",
"min-delay": "integer"
}
a1_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_secondary-ipv4-addresses_schema:
The table of VRRP secondary IPv4 addresses
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
Example
{
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
}
a1_secondary-ipv4-address_schema:
- ip-address: string
-
VRRP Secondary IPv4 address
Example
{
"ip-address": "string"
}
a1_version2_schema:
Version 2 VRRP configuration
- virtual-routers: object
-
The VRRP virtual router configuration table
-
- virtual-router: object[]
-
The VRRP virtual router being configured
-
object - tracked-objects: object
-
Track an object, reducing priority if it goes down
-
- tracked-object: object[]
-
Object to be tracked
-
object - object-name: string
-
Object to be tracked, interface name for interfaces
- priority-decrement: integer
-
Priority decrement
range:"1..254"
- session-name: string
-
VRRP Session Name
- bfd: string
-
Enable use of Bidirectional Forwarding Detection for this IP
- tracks: object
-
Track an item, reducing priority if it goes down
-
- track: object[]
-
Object to be tracked
-
object - priority: integer
-
Priority decrement
range:"1..254" default:"100" - interface-name: string
-
Object to be tracked, interface name for interfaces
- timer: object
-
Set advertisement timer
-
- advertisement-time-in-msec: integer
-
Advertisement time in milliseconds
range:"100..40950" units:"millisecond" - forced: null
-
TRUE - Force configured timer values to be used, required when configured in milliseconds
- advertisement-time-in-sec: integer
-
Advertisement time in seconds
range:"1..255" units:"second"
- primary-ipv4-address: string
-
The Primary VRRP IPv4 address
- priority: integer
-
Priority value
range:"1..254" default:"100" - preempt: integer
-
Preempt Master router if higher priority
range:"0..3600" default:"0" - secondary-ipv4-addresses: object
-
The table of VRRP secondary IPv4 addresses
-
- secondary-ipv4-address: object[]
-
A VRRP secondary IPv4 address
-
object - ip-address: string
-
VRRP Secondary IPv4 address
- accept-mode-disable: null
-
Disable Accept Mode for this virtual IPAddress
- vr-id: integer
-
VRID Virtual Router Identifier
range:"1..255" - text-password: string
-
Authentication password, 8 chars max
Example
{
"virtual-routers": {
"virtual-router": [
{
"tracked-objects": {
"tracked-object": [
{
"object-name": "string",
"priority-decrement": "integer"
}
]
},
"session-name": "string",
"bfd": "string",
"tracks": {
"track": [
{
"priority": "integer",
"interface-name": "string"
}
]
},
"timer": {
"advertisement-time-in-msec": "integer",
"forced": [ null ],
"advertisement-time-in-sec": "integer"
},
"primary-ipv4-address": "string",
"priority": "integer",
"preempt": "integer",
"secondary-ipv4-addresses": {
"secondary-ipv4-address": [
{
"ip-address": "string"
}
]
},
"accept-mode-disable": [ null ],
"vr-id": "integer",
"text-password": "string"
}
]
}
}
a1_bfd_schema:
BFD configuration
- interval: integer
-
Hello interval for BFD sessions created by vrrp
units:"millisecond" - detection-multiplier: integer
-
Detection multiplier for BFD sessions created by vrrp
range:"2..50"
Example
{
"interval": "integer",
"detection-multiplier": "integer"
}
TRAP-HOST-TABLE:
Common node of snmp, vrf
- trap-hosts: object
-
Specify hosts to receive SNMP notifications
-
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-hosts": {
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
}
APPLIED-TO:
Common node of rule, rule-set
- applied-to: object
-
Applied to the Rule or Ruleset
-
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
CONTEXT-MAPPING-TABLE:
Common node of snmp, vrf
- context-mappings: object
-
List of context names
-
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
VAR-BIND-TABLE:
Common node of root-cause, non-root-cause
- var-binds: object
-
Varbinds to match
-
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
CONTEXT-TABLE:
Common node of snmp, vrf
- contexts: object
-
List of Context Names
-
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"contexts": {
"context": [
{
"context-name": "string"
}
]
}
}
a1_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a1_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a1_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a1_threshold_schema:
SNMP logging threshold
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
a1_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a1_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a1_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a1_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a1_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a1_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a1_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a1_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a1_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a1_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a1_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a1_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a1_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a1_notification_schema:
Enable SNMP notifications
- vrrp: object
-
VRRP-MIB notification configuration
-
- enable: null
-
Enable VRRP-MIB notifications
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"vrrp": {
"enable": [ null ]
},
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
}
a1_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a1_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a1_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a1_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a1_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a1_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a1_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a1_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a1_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"millisecond" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a1_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a1_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a1_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a1_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a1_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"millisecond" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a1_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"millisecond" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a1_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a1_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a1_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a1_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - threshold: integer
-
Threshold request feature timeout
range:"0..100000" units:"second" default:"50000" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a1_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a1_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a1_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a1_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a1_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a1_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a1_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a1_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a1_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a1_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}